パッケージとプラグインの開発

コンテンツ

パッケージの紹介

パッケージを使用すると、簡単に共有できるモジュール式コードを作成できます。最小限のパッケージは次のもので構成されます。

pubspec.yaml: パッケージ名を宣言するメタデータファイル、バージョン、作成者など。
lib: のlibディレクトリにはパブリックコードが含まれていますパッケージ、少なくとも単一の<package-name>.dartファイル。

パッケージの種類

パッケージには複数の種類のコンテンツを含めることができます。

ダーツパッケージ

Dart で書かれた一般的なパッケージ、たとえば、pathパッケージ。これらの一部には Flutter 固有のものが含まれる可能性があります機能があるため、 Flutter フレームワークは、その使用を Flutter のみに制限します。たとえば、fluroパッケージ。

プラグインパッケージ

で書かれた API を含む特殊な Dart パッケージ Dart コードと 1 つ以上のプラットフォーム固有の組み合わせ実装。

Android 用のプラグインパッケージを作成できる (Kotlin または Java を使用)、iOS (Swift または Objective-C を使用)、 Web、macOS、Windows、Linux、または任意の組み合わせその。

具体的な例としては、url_launcherプラグインパッケージ。の使用方法を確認するには、url_launcherパッケージとその方法 Web のサポートを実装するために拡張されました。 Harry Terkelsen による Medium の記事を参照してください。Flutter Web プラグインの作成方法、パート 1。

FFI プラグインパッケージ

で書かれた API を含む特殊な Dart パッケージ Dart コードと 1 つ以上のプラットフォーム固有の組み合わせ Dart FFI() を使用する実装アンドロイド、iOS、マックOS）。

Dart パッケージの開発

次の手順では、Flutter の作成方法を説明します。パッケージ。

ステップ 1: パッケージを作成する

スターター Flutter パッケージを作成するには、使用--template=packageフラグ付きflutter create:

$ flutter create --template=package hello

これにより、パッケージプロジェクトが作成されますhello次の内容を含むフォルダー:

ライセンス: (ほとんどが) 空のライセンステキストファイル。
テスト/hello_test.dart: の単体テストパッケージ用。
こんにちは。iml: IntelliJ IDE によって使用される構成ファイル。
.gitignore: Git にどのファイルまたはプロジェクト内で無視するフォルダー。
.metadata: IDE がプロパティを追跡するために使用する隠しファイル Flutter プロジェクトの。
pubspec.yaml: を指定するメタデータを含む yaml ファイルパッケージの依存関係。パブツールによって使用されます。
README.md: 簡単に説明したスターターマークダウンファイルパッケージの目的。
lib/hello.dart: パッケージの Dart コードを含むスターターアプリ。
.idea/modules.xml、.idea/workspace.xml: 設定ファイルを含む隠しフォルダー IntelliJ IDE の場合。
変更ログ.md: 追跡用の（ほとんど）空のマークダウンファイルパッケージのバージョンが変更されます。

ステップ 2: パッケージを実装する

純粋な Dart パッケージの場合は、機能を追加するだけですメインの中のlib/<package name>.dartファイル、または、libディレクトリ。

パッケージをテストするには、以下を追加します単体テストでtestディレクトリ。

整理方法の詳細については、パッケージ内容、を参照してくださいダーツライブラリパッケージドキュメンテーション。

プラグインパッケージの開発

を呼び出すパッケージを開発したい場合は、プラットフォーム固有の API、プラグインパッケージを開発する必要があります。

API はプラットフォーム固有のを使用した実装プラットフォームチャンネル。

フェデレーションプラグイン

フェデレーテッドプラグインは、サポートを分割する方法です。異なるプラットフォームを個別のパッケージに分割します。したがって、フェデレーションプラグインは iOS に対して 1 つのパッケージを使用できます。 Android 用、Web 用、もう 1 つは自動車用です (IoT デバイスの例として)。このアプローチには他の利点もありますが、特に、ドメインの専門家が既存のプラグインを拡張して、彼らが最もよく知っているプラットフォームで動作するようにします。

フェデレーションプラグインには次のパッケージが必要です。

アプリ向けパッケージ: プラグインユーザーがプラグインを使用するために依存するパッケージ。このパッケージは、Flutter アプリで使用される API を指定します。
プラットフォームパッケージ: プラットフォーム固有のコンポーネントを含む 1 つ以上のパッケージ実装コード。アプリ向けパッケージは以下を呼び出しますこれらのパッケージはアプリには含まれていません。プラットフォーム固有の機能が含まれていない限りエンドユーザーがアクセスできるようになります。
プラットフォームインターフェースパッケージ: アプリ向けパッケージを接着するパッケージプラットフォームパッケージに追加します。このパッケージは、プラットフォームパッケージが実装する必要があるインターフェイスアプリ向けパッケージをサポートします。単一のパッケージを持つこのインターフェイスを定義すると、すべてのプラットフォームがパッケージは同じ機能を統一された方法で実装します。

承認されたフェデレーションプラグイン

理想的には、プラットフォーム実装を追加する場合、統合プラグインの場合は、パッケージと調整します作成者に実装を含めてください。このように、原作者は、支持するあなたの実装。

たとえば、次のように書いたとします。foobar_windows(想像上の) の実装foobarプラグイン。承認されたプラグインでは、オリジナルfoobar著者 Windows 実装を依存関係として追加しますアプリ向けパッケージの pubspec 内。次に、開発者がfoobarプラグイン Flutter アプリ、Windows 実装では、他の承認された実装と同様に、アプリで自動的に利用可能になります。

非承認のフェデレーションプラグイン

何らかの理由で実装を取得できない場合元のプラグイン作成者によって追加され、その後プラグインが追加されますはいいえ支持されました。開発者は引き続き使用できます実装しますが、プラグインを手動で追加する必要がありますアプリの pubspec ファイルに。そこで、開発者は、両方を含める必要がありますfoobar依存とのfoobar_windows達成するための依存完全な機能。

フェデレーションプラグインの詳細については、なぜそれが役立つのか、またどのように役立つのか実装されました。Harry Terkelsen による Medium の記事を参照してください。Flutter Web プラグインの作成方法、パート 2。

プラグインがサポートするプラットフォームの指定

プラグインは、サポートするプラットフォームを指定できます。にキーを追加するplatformsの地図pubspec.yamlファイル。例えば、次の pubspec ファイルは、flutter:の地図helloプラグイン、 iOS と Android のみをサポートします。

flutter:
  plugin:
    platforms:
      android:
        package: com.example.hello
        pluginClass: HelloPlugin
      ios:
        pluginClass: HelloPlugin

より多くのプラットフォームにプラグイン実装を追加する場合、のplatformsそれに応じてマップを更新する必要があります。たとえば、pubspec ファイル内のマップは次のとおりです。のためにhelloプラグイン、 macOS と Web のサポートを追加するために更新された場合:

flutter:
  plugin:
    platforms:
      android:
        package: com.example.hello
        pluginClass: HelloPlugin
      ios:
        pluginClass: HelloPlugin
      macos:
        pluginClass: HelloPlugin
      web:
        pluginClass: HelloPlugin
        fileName: hello_web.dart

フェデレーテッドプラットフォームパッケージ

プラットフォームパッケージは同じ形式を使用します。が含まれますimplementsを示すエントリどのアプリ向けパッケージを実装するか。例えば、あるhello_windowsWindows を含むプラグインの実装hello次のようになりますflutter:地図：

flutter:
  plugin:
    implements: hello
    platforms:
      windows:
        pluginClass: HelloPlugin

承認された実装

アプリ向けパッケージは、それに依存し、それをdefault_packageの中にplatforms:地図。もしhello上記のプラグインが承認されていますhello_windows、それは次のようになります:

flutter:
  plugin:
    platforms:
      android:
        package: com.example.hello
        pluginClass: HelloPlugin
      ios:
        pluginClass: HelloPlugin
      windows:
        default_package: hello_windows

dependencies:
  hello_windows: ^1.0.0

ここに示すように、アプリ向けパッケージには次のものを含めることができることに注意してください。パッケージ内に実装されている一部のプラットフォーム、およびその他の承認されたフェデレーション実装。

iOS と macOS の共有実装

多くのフレームワークは、iOS と macOS の両方を同一の機能でサポートしています。またはほとんど同一の API を実装できるようになります。同じコードベースを持つ iOS と macOS の両方に対応するいくつかのプラグイン。通常、各プラットフォームの実装は独自に行われます。フォルダですが、sharedDarwinSourceオプションで iOS が許可されますと macOS では代わりに同じフォルダーを使用します。

flutter:
  plugin:
    platforms:
      ios:
        pluginClass: HelloPlugin
        sharedDarwinSource: true
      macos:
        pluginClass: HelloPlugin
        sharedDarwinSource: true

environment:
  sdk: ^3.0.0
  # Flutter versions prior to 3.7 did not support the
  # sharedDarwinSource option.
  flutter: ">=3.7.0"

いつsharedDarwinSourceの代わりに有効になりますのiosiOS のディレクトリとmacosディレクトリ macOS の場合、両方のプラットフォームで共有darwinすべてのコードとリソースのディレクトリ。有効にする場合このオプションを使用するには、既存のファイルを移動する必要がありますからiosとmacos共有ディレクトリにコピーします。あなた podspec ファイルを更新して、両方のプラットフォームの依存関係と展開ターゲット、例えば：

  s.ios.dependency 'Flutter'
  s.osx.dependency 'FlutterMacOS'
  s.ios.deployment_target = '11.0'
  s.osx.deployment_target = '10.14'

ステップ 1: パッケージを作成する

プラグインパッケージを作成するには、--template=pluginフラグ付きflutter create。

使用--platforms=オプションの後にプラットフォームを指定するカンマ区切りのリストプラグインがサポートしていること。利用可能なプラットフォームは次のとおりです。android、ios、web、linux、macos、とwindows。プラットフォームが指定されていない場合、結果のプロジェクトはどのプラットフォームもサポートしません。

使用--org組織を指定するオプション、逆ドメイン名表記を使用します。この値が使用されますさまざまなパッケージおよびバンドル識別子で生成されたプラグインコード。

使用-aAndroidの言語を指定するオプションまたは-iiOS の言語を指定するオプション。選んでください一次のいずれか:

$ flutter create --org com.example --template=plugin --platforms=android,ios,linux,macos,windows -a kotlin hello

$ flutter create --org com.example --template=plugin --platforms=android,ios,linux,macos,windows -a java hello

$ flutter create --org com.example --template=plugin --platforms=android,ios,linux,macos,windows -i objc hello

$ flutter create --org com.example --template=plugin --platforms=android,ios,linux,macos,windows -i swift hello

これにより、次の場所にプラグインプロジェクトが作成されます。helloフォルダ次のような専門的な内容が含まれます。

lib/hello.dart: プラグインの Dart API。
android/src/main/java/com/example/hello/HelloPlugin.kt: Android プラットフォーム固有のプラグイン API の実装コトリンで。
ios/Classes/HelloPlugin.m: iOS プラットフォーム固有のプラグイン API の実装 Objective-C で。
example/: プラグインに依存する Flutter アプリ、そしてその使用方法を説明します。

デフォルトでは、プラグインプロジェクトは iOS コード用の Swift を使用し、 Android コード用の Kotlin。 Objective-C または Java をお好みの場合は、次を使用して iOS 言語を指定できます-iそしてその Android 言語を使用する-a。例えば：

$ flutter create --template=plugin --platforms=android,ios -i objc hello

$ flutter create --template=plugin --platforms=android,ios -a java hello

ステップ 2: パッケージを実装する

プラグインパッケージには複数のプラットフォーム用のコードが含まれていますいくつかのプログラミング言語で書かれており、スムーズなエクスペリエンスを確保するには、いくつかの特定の手順が必要です。

ステップ 2a: パッケージ API (.dart) を定義する

プラグインパッケージの API は Dart コードで定義されます。メインを開くhello/お気に入りのフォルダー flutterエディター。ファイルを見つけますlib/hello.dart。

ステップ 2b: Android プラットフォームコード (.kt/.java) を追加する

Android Studio を使用して Android コードを編集することをお勧めします。

次に、次の手順を実行します。

Android Studioを起動します。
選択する既存の Android Studio プロジェクトを開くの中にAndroid Studio へようこそダイアログ、または選択しますファイル > 開くメニューから、そして、hello/example/android/build.gradleファイル。
の中にグラドル同期ダイアログ、選択OK。
の中にAndroid Gradle プラグインのアップデートダイアログ、選択するこのプロジェクトについてはもう通知しないでください。

プラグインの Android プラットフォームコードは次の場所にあります。hello/java/com.example.hello/HelloPlugin。

Android Studio からサンプルアプリを実行するには、次のようにします。実行（▶）ボタンを押します。

ステップ 2c: iOS プラットフォームコード (.swift/.h+.m) を追加します。

Xcode を使用して iOS コードを編集することをお勧めします。

Xcode で iOS プラットフォームコードを編集する前に、まず、コードが少なくとも 1 回ビルドされていることを確認してください (つまり、IDE/エディタからサンプルアプリを実行します。またはターミナルで実行しますcd hello/example; flutter build ios --no-codesign）。

次に、次の手順を実行します。

Xcodeを起動します。
選択するファイル > 開くを選択し、hello/example/ios/Runner.xcworkspaceファイル。

プラグインの iOS プラットフォームコードは次の場所にあります。Pods/Development Pods/hello/../../example/ios/.symlinks/plugins/hello/ios/Classesプロジェクトナビゲータで。 (使用している場合sharedDarwinSource、パスは次で終わりますhello/darwin/Classesその代わり。）

実行 (▶) ボタンを押すと、サンプルアプリを実行できます。

ステップ 2d: Linux プラットフォームコード (.h+.cc) を追加する

IDE を使用して Linux コードを編集することをお勧めします。 C++ の統合。以下の手順は次のとおりです。「C/C++」および「CMake」拡張機能を備えた Visual Studio Code インストールされていますが、他の IDE 用に調整できます。

IDE で Linux プラットフォームコードを編集する前に、まず、コードが少なくとも 1 回ビルドされていることを確認してください (つまり、Flutter からサンプルアプリを実行します) IDE/エディタ、またはターミナルで実行cd hello/example; flutter build linux）。

次に、次の手順を実行します。

Visual Studio コードを起動します。
を開きますhello/example/linux/ディレクトリ。
選ぶはいプロンプトで次のように尋ねます。Would you like to configure project "linux"?。これにより、C++ オートコンプリートが機能するようになります。

プラグインの Linux プラットフォームコードは次の場所にあります。flutter/ephemeral/.plugin_symlinks/hello/linux/。

次を使用してサンプルアプリを実行できますflutter run。ノート：実行可能な Flutter アプリケーションの作成 Linux では、次の手順が必要です。flutterツールなので、エディターが CMake を提供している場合でも、その方法で統合を構築して実行することはできません正しく動作します。

ステップ 2e: macOS プラットフォームコード (.swift) を追加する

Xcode を使用して macOS コードを編集することをお勧めします。

Xcode で macOS プラットフォームコードを編集する前に、まず、コードが少なくとも 1 回ビルドされていることを確認してください (つまり、IDE/エディタからサンプルアプリを実行します。またはターミナルで実行しますcd hello/example; flutter build macos）。

次に、次の手順を実行します。

Xcodeを起動します。
選択するファイル > 開くを選択し、hello/example/macos/Runner.xcworkspaceファイル。

プラグインの macOS プラットフォームコードは次の場所にあります。Pods/Development Pods/hello/../../example/macos/Flutter/ephemeral/.symlinks/plugins/hello/macos/Classesプロジェクトナビゲータで。 (使用している場合sharedDarwinSource、パスは次で終わりますhello/darwin/Classesその代わり。）

実行 (▶) ボタンを押すと、サンプルアプリを実行できます。

ステップ 2f: Windows プラットフォームコード (.h+.cpp) を追加します。

Visual Studio を使用して Windows コードを編集することをお勧めします。

Visual Studio で Windows プラットフォームコードを編集する前に、まず、コードが少なくとも 1 回ビルドされていることを確認してください (つまり、IDE/エディタからサンプルアプリを実行します。またはターミナルで実行しますcd hello/example; flutter build windows）。

次に、次の手順を実行します。

Visual Studio を起動します。
選択するプロジェクトまたはソリューションを開くを選択し、hello/example/build/windows/hello_example.slnファイル。

プラグインの Windows プラットフォームコードは次の場所にあります。hello_plugin/Source Filesとhello_plugin/Header Filesのソリューションエクスプローラー。

右クリックしてサンプルアプリを実行できます。hello_exampleのソリューションエクスプローラーと選択スタートアッププロジェクトとして設定、実行（▶）ボタンを押します。重要：後プラグインコードに変更を加える場合は、選択する必要がありますビルド > ソリューションのビルド再度実行する前、そうでない場合代わりに、ビルドされたプラグインの古いコピーが実行されます変更を含む最新バージョンの。

ステップ 2g: API とプラットフォームコードを接続する

最後に、Dart コードで書かれた API を次のように接続する必要があります。プラットフォーム固有の実装。これは、プラットフォームチャンネル、またはプラットフォームで定義されたインターフェイスを通じてインターフェースパッケージ。

既存のプラグインプロジェクトにプラットフォームのサポートを追加する

特定のプラットフォームのサポートを既存のプラグインプロジェクト、実行flutter createとの--template=pluginプロジェクトディレクトリに再度フラグを立てます。たとえば、既存のプラグインに Web サポートを追加するには、次を実行します。

$ flutter create --template=plugin --platforms=web .

このコマンドで更新に関するメッセージが表示された場合は、pubspec.yamlファイルを作成するには、提供される指示に従ってください。

Dart プラットフォームの実装

多くの場合、非 Web プラットフォームの実装では、上に示したように、プラットフォーム固有の実装言語。しかし、プラットフォーム実装では、プラットフォーム固有の Dart も使用できます。

Dart 専用プラットフォームの実装

場合によっては、一部のプラットフォームでは、完全に Dart で実装されます (たとえば、FFI を使用)。 Web 以外のプラットフォームでの Dart 専用プラットフォームの実装の場合、を交換してくださいpluginClasspubspec.yaml でdartPluginClass。ここにありますhello_windows上記の例は、 Dart のみの実装:

flutter:
  plugin:
    implements: hello
    platforms:
      windows:
        dartPluginClass: HelloPluginWindows

このバージョンでは、C++ Windows コードはなく、代わりにをサブクラス化するhelloプラグインの Dart プラットフォームインターフェイスクラスとHelloPluginWindows静的を含むクラスregisterWith()方法。このメソッドは起動時に呼び出されます。 Dart 実装の登録に使用できます。

class HelloPluginWindows extends HelloPluginPlatform {
  /// Registers this class as the default instance of [HelloPluginPlatform].
  static void registerWith() {
    HelloPluginPlatform.instance = HelloPluginWindows();
  }

ハイブリッドプラットフォームの実装

プラットフォームの実装では、Dart とプラットフォーム固有の言語。たとえば、プラグインは別のプラットフォームチャネルを使用できます。プラットフォームごとにチャネルをカスタマイズできるようにします。

ハイブリッド実装では両方の登録システムを使用します上で説明した。ここにありますhello_windows上記の例は、ハイブリッド実装:

flutter:
  plugin:
    implements: hello
    platforms:
      windows:
        dartPluginClass: HelloPluginWindows
        pluginClass: HelloPlugin

ダーツHelloPluginWindowsクラスはregisterWith()上では Dart のみの実装を示していますが、C++ ではHelloPluginclass は C++ のみの実装と同じになります。

プラグインをテストする

自動テストを使用してプラグインをテストすることをお勧めします機能が後退しないようにするためコードに変更を加えたとき。

プラグインのテストについて詳しくは、チェックアウトプラグインのテスト。 Flutter アプリのテストを作成している場合プラグインがクラッシュを引き起こしているため、チェックアウトプラグインテストでの flutter。

FFI プラグインパッケージの開発

を使用してネイティブ API を呼び出すパッケージを開発したい場合は、 Dart の FFI では、FFI プラグインパッケージを開発する必要があります。

FFI プラグインパッケージと (非 FFI) プラグインパッケージの両方をサポートネイティブコードをバンドルしますが、FFI プラグインパッケージはサポートしませんメソッドチャネルにはメソッドチャネル登録コードが含まれます。両方のメソッドチャネルを使用するプラグインを実装する場合および FFI の場合は、(非 FFI) プラグインを使用します。プラットフォームごとに選択できます FFI または (非 FFI) プラグインを使用します。

FFI プラグインパッケージは Flutter 3.0 で導入されました。古い Flutter バージョンを対象とする場合は、(FFI 以外の) プラグインを使用できます。

ステップ 1: パッケージを作成する

スターター FFI プラグインパッケージを作成するには、使用--template=plugin_ffiフラグ付きflutter create:

$ flutter create --template=plugin_ffi hello

これにより、FFI プラグインプロジェクトが作成されます。hello次の特殊なコンテンツを含むフォルダー:

ライブラリ: プラグインの API を定義する Dart コード、を使用してネイティブコードを呼び出しますdart:ffi。

送信元: ネイティブソースコード、およびCMakeLists.txtそのソースコードをダイナミックライブラリにビルドするためのファイル。

プラットフォームフォルダー(android、ios、windows、など）：ネイティブコードをビルドしてバンドルするためのビルドファイルプラットフォームアプリケーションを備えたライブラリ。

ステップ 2: ネイティブコードの構築とバンドル

のpubspec.yamlFFI プラグインを次のように指定します。

  plugin:
    platforms:
      some_platform:
        ffiPlugin: true

この構成はネイティブビルドを呼び出しますさまざまなターゲットプラットフォームおよびバンドル向けこれらの FFI プラグインを使用する Flutter アプリケーションのバイナリ。

これと組み合わせることができますdartPluginClass、 FFI が統合プラグイン内の 1 つのプラットフォームの実装:

  plugin:
    implements: some_other_plugin
    platforms:
      some_platform:
        dartPluginClass: SomeClass
        ffiPlugin: true

プラグインには FFI チャネルとメソッドチャネルの両方を含めることができます。

  plugin:
    platforms:
      some_platform:
        pluginClass: SomeName
        ffiPlugin: true

FFI によって呼び出されるネイティブビルドシステム (およびメソッドチャネル) プラグインは次のとおりです。

Android の場合: Gradle。ネイティブビルド用に Android NDK を呼び出します。
- のドキュメントを参照してください。android/build.gradle。
iOS および macOS の場合: Xcode、CocoaPods 経由。
- のドキュメントを参照してください。ios/hello.podspec。
- のドキュメントを参照してください。macos/hello.podspec。
Linux および Windows の場合: CMake。
- のドキュメントを参照してください。linux/CMakeLists.txt。
- のドキュメントを参照してください。windows/CMakeLists.txt。

ステップ 3: ネイティブコードへのバインド

ネイティブコードを使用するには、Dart のバインディングが必要です。

これらを手動で記述することを避けるために、ヘッダーファイルから生成されます。 (src/hello.h）にpackage:ffigen。次のコマンドを実行してバインディングを再生成します。

$  flutter pub run ffigen --config ffigen.yaml

ステップ 4: ネイティブコードの呼び出し

非常に実行時間が短いネイティブ関数を直接実行できます。任意のアイソレートから呼び出されます。例については、を参照してください。sumのlib/hello.dart。

実行時間の長い関数は、ヘルパーを分離するフレーム落ちを避けるため flutterアプリケーション。例については、を参照してください。sumAsyncのlib/hello.dart。

ドキュメントの追加

次のドキュメントを追加することをお勧めします。すべてのパッケージに:

あREADME.mdパッケージを紹介するファイル
あCHANGELOG.md各バージョンでの変更点を文書化したファイル
あLICENSEパッケージに適用される条件を含むファイル認可されています
すべてのパブリック API の API ドキュメント (詳細は以下を参照)

APIドキュメント

パッケージを公開すると、 API ドキュメントは自動的に生成され、 pub.dev/documentation に公開されます。たとえば、次のドキュメントを参照してください。device_info。

API ドキュメントをローカルで生成したい場合は、開発マシンでは、次のコマンドを使用します。

ディレクトリをパッケージの場所に変更します。
```
cd ~/dev/mypackage
```
ドキュメントツールに、 Flutter SDK が見つかります (反映するように次のコマンドを変更します) どこに置いたのか):
```
   export FLUTTER_ROOT=~/dev/flutter  # on macOS or Linux

   set FLUTTER_ROOT=~/dev/flutter     # on Windows
```

を実行します。dart doc道具 (Flutter SDK の一部として含まれています):

   $FLUTTER_ROOT/bin/cache/dart-sdk/bin/dart doc   # on macOS or Linux

   %FLUTTER_ROOT%\bin\cache\dart-sdk\bin\dart doc  # on Windows

API ドキュメントの作成方法に関するヒントについては、次を参照してください。効果的な Dart ドキュメント。

LICENSE ファイルへのライセンスの追加

各 LICENSE ファイル内の個別のライセンス 80 個のハイフンで区切る必要がありますライン上で自分自身で。

LICENSE ファイルに複数のファイルが含まれている場合コンポーネントライセンス、次に各コンポーネントライセンスは、次の名前で始まる必要があります。コンポーネントライセンスが適用されるパッケージ、各パッケージ名をそれぞれの行に配置し、と分割されたパッケージ名のリスト実際のライセンステキストは空行で区切ります。 (パッケージの名前が一致する必要はありません。パブパッケージ。たとえば、パッケージ自体に次のものが含まれる場合があります。複数のサードパーティソースからのコード、それぞれにライセンスを含める必要がある場合があります)。

次の例は、適切に構成されたライセンスファイルを示しています。

package_1

<some license text>

--------------------------------------------------------------------------------
package_2

<some license text>

以下は、適切に構成されたライセンスファイルの別の例です。

package_1

<some license text>

--------------------------------------------------------------------------------
package_1
package_2

<some license text>

以下は、適切に構成されていないライセンスファイルの例です。

<some license text>

--------------------------------------------------------------------------------
<some license text>

不適切に構成されたライセンスファイルの別の例:

package_1

<some license text>
--------------------------------------------------------------------------------
<some license text>

パッケージを公開する

パッケージを実装したら、次の場所で公開できます。パブ.dev他の開発者が簡単に使用できるようにします。

公開する前に、必ずご確認ください。pubspec.yaml、README.md、とCHANGELOG.mdファイルを確認するために内容は完全かつ正確です。また、改善するには、パッケージの品質と使いやすさ（そしてそれを実現するために） Flutter のお気に入りのステータスを達成する可能性が高くなります)、次の項目を含めることを検討してください。

多様なコード使用例
スクリーンショット、アニメーション GIF、またはビデオ
対応するコードリポジトリへのリンク

次に、publish コマンドを実行します。dry-runモードすべてが分析に合格したかどうかを確認するには、次のようにします。

$ flutter pub publish --dry-run

次のステップは、pub.dev への公開です。ただし、準備ができていることを確認してください。出版は永遠です:

$ flutter pub publish

公開の詳細については、ドキュメントの公開dart.dev で。

パッケージの相互依存関係の処理

パッケージを開発している場合helloそれはに依存します別のパッケージによって公開されている Dart API を追加する必要がありますそのパッケージをdependenciesあなたのセクションpubspec.yamlファイル。以下のコードは Dart API を作成しますのurl_launcher利用可能なプラグインhello:

dependencies:
  url_launcher: ^5.0.0

いまなら可能ですimport 'package:url_launcher/url_launcher.dart'とlaunch(someUrl)Dartコードの中でhello。

これは、パッケージを含める方法と何ら変わりません。 Flutter アプリまたはその他の Dart プロジェクト。

しかし、もしhelloたまたまプラグインパッケージプラットフォーム固有のコードにアクセスする必要があるによって公開されるプラットフォーム固有の APIurl_launcher、適切な依存関係宣言を追加する必要もあります以下に示すように、プラットフォーム固有のビルドファイルに追加されます。

アンドロイド

次の例では、依存関係を設定します。url_launcherのhello/android/build.gradle:

android {
    // lines skipped
    dependencies {
        compileOnly rootProject.findProject(":url_launcher")
    }
}

いまなら可能ですimport io.flutter.plugins.urllauncher.UrlLauncherPluginそしてアクセスしてくださいUrlLauncherPluginソースコード内のクラスhello/android/src。

詳細については、build.gradleファイルについては、を参照してください。Gradle ドキュメントビルドスクリプトについて。

iOS

次の例では、依存関係を設定します。url_launcherのhello/ios/hello.podspec:

Pod::Spec.new do |s|
  # lines skipped
  s.dependency 'url_launcher'

いまなら可能です#import "UrlLauncherPlugin.h"とにアクセスしますUrlLauncherPluginソースコード内のクラスでhello/ios/Classes。

詳細については、.podspecファイルについては、を参照してください。CocoaPods のドキュメントそれらの上に。

ウェブ

すべての Web 依存関係は、pubspec.yaml他の Dart パッケージと同様に、ファイルを作成します。

パッケージの紹介

パッケージの種類

Dart パッケージの開発

ステップ 1: パッケージを作成する

ステップ 2: パッケージを実装する

プラグインパッケージの開発

フェデレーションプラグイン

承認されたフェデレーション プラグイン

非承認のフェデレーション プラグイン

プラグインがサポートするプラットフォームの指定

フェデレーテッド プラットフォーム パッケージ

承認された実装

iOS と macOS の共有実装

ステップ 1: パッケージを作成する

ステップ 2: パッケージを実装する

ステップ 2a: パッケージ API (.dart) を定義する

ステップ 2b: Android プラットフォーム コード (.kt/.java) を追加する

ステップ 2c: iOS プラットフォーム コード (.swift/.h+.m) を追加します。

ステップ 2d: Linux プラットフォーム コード (.h+.cc) を追加する

ステップ 2e: macOS プラットフォーム コード (.swift) を追加する

ステップ 2f: Windows プラットフォーム コード (.h+.cpp) を追加します。

ステップ 2g: API とプラットフォーム コードを接続する

既存のプラグイン プロジェクトにプラットフォームのサポートを追加する

Dart プラットフォームの実装

Dart 専用プラットフォームの実装

ハイブリッド プラットフォームの実装

プラグインをテストする

FFI プラグイン パッケージの開発

ステップ 1: パッケージを作成する

ステップ 2: ネイティブ コードの構築とバンドル

ステップ 3: ネイティブ コードへのバインド

ステップ 4: ネイティブ コードの呼び出し

ドキュメントの追加

APIドキュメント

LICENSE ファイルへのライセンスの追加

パッケージを公開する

パッケージの相互依存関係の処理

アンドロイド

iOS

ウェブ

承認されたフェデレーションプラグイン

非承認のフェデレーションプラグイン

フェデレーテッドプラットフォームパッケージ

ステップ 2b: Android プラットフォームコード (.kt/.java) を追加する

ステップ 2c: iOS プラットフォームコード (.swift/.h+.m) を追加します。

ステップ 2d: Linux プラットフォームコード (.h+.cc) を追加する

ステップ 2e: macOS プラットフォームコード (.swift) を追加する

ステップ 2f: Windows プラットフォームコード (.h+.cpp) を追加します。

ステップ 2g: API とプラットフォームコードを接続する

既存のプラグインプロジェクトにプラットフォームのサポートを追加する

ハイブリッドプラットフォームの実装

FFI プラグインパッケージの開発

ステップ 2: ネイティブコードの構築とバンドル

ステップ 3: ネイティブコードへのバインド

ステップ 4: ネイティブコードの呼び出し